<!doctype html>
<html lang="en">
        <head>
                <meta charset="utf-8">
                <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
                <meta name="generator" content="pdoc 0.9.1" />
                <title>sudoku_generator API documentation</title>
                <meta name="description" content="This module is a sudoku generator that will write `.sudoku` files with sudoku boards …" />
                <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
                <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
                <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
                <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
                <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
                <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
                <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
                <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
                <link rel="stylesheet" type="text/css" href="github-style.css">
        </head>
        <body>
                <main>
                        <article id="content">
                                <header>
                                        <h1 class="title">Module <code>sudoku_generator</code></h1>
                                </header>
                                <section id="section-intro">
                                        <p>This module is a sudoku generator that will write <code>.sudoku</code> files with sudoku boards.</p>
                                        <p><strong>External modules</strong>: <code>random</code></p>
                                        <p><code>Compatible with Python3.7 or higher</code></p>
                                        <p><em>Repository:</em> <a href="https://github.com/rickfernandes/sudoku_solver">https://github.com/rickfernandes/sudoku_solver</a></p>
                                        <details class="source">
                                        <summary>
                                        <span>Expand source code</span>
                                        </summary>
                                        <pre><code class="python"># -*- coding: utf-8 -*-
                                                &#34;&#34;&#34;
                                                This module is a sudoku generator that will write `.sudoku` files with sudoku boards.
                                                __External modules__: `random`
                                                `Compatible with Python3.7 or higher`\n
                                                _Repository:_ https://github.com/rickfernandes/sudoku_solver
                                                &#34;&#34;&#34;
                                                from random import sample, randint
                                                FOLDER = &#39;boards/&#39;
                                                &#34;&#34;&#34;Destination folder where the `.sudoku` files will be save.&#34;&#34;&#34;
                                                def CreateOrigin():
                                                        &#34;&#34;&#34;Function to create a full sudoku board (matrix) with random numbers.
                                                        Args:
                                                                __None__
                                                        Dependencies:
                                                                `sample()` (function): from `random` module.
                                                        Returns:
                                                                `array` (matrix): returns a `9x9` filled valid suduko board.
                                                        &#34;&#34;&#34;
                                                        base = 3
                                                        side  = base*base
                                                        def Pattern(r,c):
                                                                &#34;&#34;&#34;Returns the pattern for `r` and `c`&#34;&#34;&#34;
                                                                return (base*(r%base)+r//base+c)%side
                                                        def Shuffle(s): 
                                                                &#34;&#34;&#34;Creates and shuffles an array of size `s`&#34;&#34;&#34;
                                                                return sample(s,len(s)) 
                                                        rows  = [ g*base + r for g in Shuffle(range(base)) for r in Shuffle(range(base)) ] 
                                                        &#34;&#34;&#34;Random rows array&#34;&#34;&#34;
                                                        
                                                        cols  = [ g*base + c for g in Shuffle(range(base)) for c in Shuffle(range(base)) ]
                                                        &#34;&#34;&#34;Random columns array&#34;&#34;&#34;
                                                        
                                                        nums  = Shuffle(range(1,side+1))
                                                        &#34;&#34;&#34;Random numbers array from 1 to 9 (valid sudoku numbers)&#34;&#34;&#34;
                                                        
                                                        return [[nums[Pattern(r,c)] for c in cols] for r in rows]
                                                def RemoveNums(board,num):
                                                        &#34;&#34;&#34;Function to randomly remove a certain quantity of elements from `board`.
                                                        Args:
                                                                `board` (matrix): valid filled sudoku board.
                                                                `num` (int): quantity of numbers to be removed.
                                                        Dependencies:
                                                                `randint()` (function): from `random` module
                                                        Returns:
                                                                board (matrix): returns a `9x9` (matrix) sudoku board with random `0`s
                                                        &#34;&#34;&#34;
                                                        positions = [(n//9,n%9) for n in range(0,81)]
                                                        &#34;&#34;&#34;Array with all possible positions in the matrix board&#34;&#34;&#34;
                                                        for _ in range(num):
                                                                &#34;&#34;&#34;Loops through `num` times randomly removing elements from board, using `positions` array
                                                                to keep track of removed elements&#34;&#34;&#34;
                                                                r = randint(0,len(positions)-1)
                                                                pos = positions[r]
                                                                board[pos[0]][pos[1]] = 0
                                                        return board
                                                def WriteFiles(n,rem):
                                                        &#34;&#34;&#34;Function to create and write boards (as flat string) to `.sudoku` files in `FOLDER` folder.
                                                        The boards will have `rem` missing elements (i.e. matrix positions with `0`). It has a hard limit of 10,000 boards.
                                                        Args:
                                                                `n` (int): number of boards to be created/written\n
                                                                `rem` (int): quantity of numbers to be removed from each board.
                                                        Dependencies:
                                                                __None__
                                                        Returns:
                                                                __None__
                                                        &#34;&#34;&#34;
                                                        if n &gt; 10000: n = 10000
                                                        &#34;&#34;&#34;Makes sure that at most 10,000 boards will be created. Due to file naming (i.e. :04d)&#34;&#34;&#34;
                                                        for b in range(n):
                                                                &#34;&#34;&#34;Loops n times creating and writing a board&#34;&#34;&#34;
                                                                board = RemoveNums(CreateOrigin(),rem)
                                                                with open(&#39;{}/s{:04d}.sudoku&#39;.format(FOLDER,b), &#39;w&#39;) as file:
                                                                        for row in range(9):
                                                                                for col in range(9):
                                                                                        file.write(str(board[row][col]))
                                                                                file.write(&#39;\n&#39;)
                                                if __name__ == &#39;__main__&#39;:
                                                        WriteFiles(15,randint(10,30))
                                        print(&#39;finished &#39;)</code></pre>
                                        </details>
                                </section>
                                <section>
                                </section>
                                <section>
                                        <h2 class="section-title" id="header-variables">Global variables</h2>
                                        <dl>
                                                <dt id="sudoku_generator.FOLDER"><code class="name">var <span class="ident">FOLDER</span></code></dt>
                                                <dd>
                                                <div class="desc"><p>Destination folder where the <code>.sudoku</code> files will be save.</p></div>
                                                </dd>
                                        </dl>
                                </section>
                                <section>
                                        <h2 class="section-title" id="header-functions">Functions</h2>
                                        <dl>
                                                <dt id="sudoku_generator.CreateOrigin"><code class="name flex">
                                                <span>def <span class="ident">CreateOrigin</span></span>(<span>)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to create a full sudoku board (matrix) with random numbers.</p>
                                                <h2 id="args">Args</h2>
                                                <p><strong>None</strong></p>
                                                <h2 id="dependencies">Dependencies</h2>
                                                <p><code>sample()</code> (function): from <code>random</code> module.</p>
                                                <h2 id="returns">Returns</h2>
                                                <p><code>array</code> (matrix): returns a <code>9x9</code> filled valid suduko board.</p></div>
                                                <details class="source">
                                                <summary>
                                                <span>Expand source code</span>
                                                </summary>
                                                <pre><code class="python">def CreateOrigin():
                                                                &#34;&#34;&#34;Function to create a full sudoku board (matrix) with random numbers.
                                                                Args:
                                                                        __None__
                                                                Dependencies:
                                                                        `sample()` (function): from `random` module.
                                                                Returns:
                                                                        `array` (matrix): returns a `9x9` filled valid suduko board.
                                                                &#34;&#34;&#34;
                                                                base = 3
                                                                side  = base*base
                                                                def Pattern(r,c):
                                                                        &#34;&#34;&#34;Returns the pattern for `r` and `c`&#34;&#34;&#34;
                                                                        return (base*(r%base)+r//base+c)%side
                                                                def Shuffle(s): 
                                                                        &#34;&#34;&#34;Creates and shuffles an array of size `s`&#34;&#34;&#34;
                                                                        return sample(s,len(s)) 
                                                                rows  = [ g*base + r for g in Shuffle(range(base)) for r in Shuffle(range(base)) ] 
                                                                &#34;&#34;&#34;Random rows array&#34;&#34;&#34;
                                                                
                                                                cols  = [ g*base + c for g in Shuffle(range(base)) for c in Shuffle(range(base)) ]
                                                                &#34;&#34;&#34;Random columns array&#34;&#34;&#34;
                                                                
                                                                nums  = Shuffle(range(1,side+1))
                                                                &#34;&#34;&#34;Random numbers array from 1 to 9 (valid sudoku numbers)&#34;&#34;&#34;
                                                                
                                                return [[nums[Pattern(r,c)] for c in cols] for r in rows]</code></pre>
                                                </details>
                                                </dd>
                                                <dt id="sudoku_generator.RemoveNums"><code class="name flex">
                                                <span>def <span class="ident">RemoveNums</span></span>(<span>board, num)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to randomly remove a certain quantity of elements from <code>board</code>.</p>
                                                <h2 id="args">Args</h2>
                                                <p><code>board</code> (matrix): valid filled sudoku board.
                                                <code>num</code> (int): quantity of numbers to be removed.</p>
                                                <h2 id="dependencies">Dependencies</h2>
                                                <p><code>randint()</code> (function): from <code>random</code> module</p>
                                                <h2 id="returns">Returns</h2>
                                                <p>board (matrix): returns a <code>9x9</code> (matrix) sudoku board with random <code>0</code>s</p></div>
                                                <details class="source">
                                                <summary>
                                                <span>Expand source code</span>
                                                </summary>
                                                <pre><code class="python">def RemoveNums(board,num):
                                                                &#34;&#34;&#34;Function to randomly remove a certain quantity of elements from `board`.
                                                                Args:
                                                                        `board` (matrix): valid filled sudoku board.
                                                                        `num` (int): quantity of numbers to be removed.
                                                                Dependencies:
                                                                        `randint()` (function): from `random` module
                                                                Returns:
                                                                        board (matrix): returns a `9x9` (matrix) sudoku board with random `0`s
                                                                &#34;&#34;&#34;
                                                                positions = [(n//9,n%9) for n in range(0,81)]
                                                                &#34;&#34;&#34;Array with all possible positions in the matrix board&#34;&#34;&#34;
                                                                for _ in range(num):
                                                                        &#34;&#34;&#34;Loops through `num` times randomly removing elements from board, using `positions` array
                                                                        to keep track of removed elements&#34;&#34;&#34;
                                                                        r = randint(0,len(positions)-1)
                                                                        pos = positions[r]
                                                                        board[pos[0]][pos[1]] = 0
                                                return board</code></pre>
                                                </details>
                                                </dd>
                                                <dt id="sudoku_generator.WriteFiles"><code class="name flex">
                                                <span>def <span class="ident">WriteFiles</span></span>(<span>n, rem)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to create and write boards (as flat string) to <code>.sudoku</code> files in <code><a title="sudoku_generator.FOLDER" href="#sudoku_generator.FOLDER">FOLDER</a></code> folder.
                                        The boards will have <code>rem</code> missing elements (i.e. matrix positions with <code>0</code>). It has a hard limit of 10,000 boards.</p>
                                        <h2 id="args">Args</h2>
                                        <p><code>n</code> (int): number of boards to be created/written</p>
                                        <p><code>rem</code> (int): quantity of numbers to be removed from each board.</p>
                                        <h2 id="dependencies">Dependencies</h2>
                                        <p><strong>None</strong></p>
                                        <h2 id="returns">Returns</h2>
                                        <p><strong>None</strong></p></div>
                                        <details class="source">
                                        <summary>
                                        <span>Expand source code</span>
                                        </summary>
                                        <pre><code class="python">def WriteFiles(n,rem):
                                                        &#34;&#34;&#34;Function to create and write boards (as flat string) to `.sudoku` files in `FOLDER` folder.
                                                        The boards will have `rem` missing elements (i.e. matrix positions with `0`). It has a hard limit of 10,000 boards.
                                                        Args:
                                                                `n` (int): number of boards to be created/written\n
                                                                `rem` (int): quantity of numbers to be removed from each board.
                                                        Dependencies:
                                                                __None__
                                                        Returns:
                                                                __None__
                                                        &#34;&#34;&#34;
                                                        if n &gt; 10000: n = 10000
                                                        &#34;&#34;&#34;Makes sure that at most 10,000 boards will be created. Due to file naming (i.e. :04d)&#34;&#34;&#34;
                                                        for b in range(n):
                                                                &#34;&#34;&#34;Loops n times creating and writing a board&#34;&#34;&#34;
                                                                board = RemoveNums(CreateOrigin(),rem)
                                                                with open(&#39;{}/s{:04d}.sudoku&#39;.format(FOLDER,b), &#39;w&#39;) as file:
                                                                        for row in range(9):
                                                                                for col in range(9):
                                                                                        file.write(str(board[row][col]))
                                        file.write(&#39;\n&#39;)</code></pre>
                                        </details>
                                        </dd>
                                </dl>
                        </section>
                        <section>
                        </section>
                </article>
                <nav id="sidebar">
                        <h1>Index</h1>
                        <div class="toc">
                        <ul></ul>
                </div>
                <ul id="index">
                        <li><h3><a href="#header-variables">Global variables</a></h3>
                        <ul class="">
                                <li><code><a title="sudoku_generator.FOLDER" href="#sudoku_generator.FOLDER">FOLDER</a></code></li>
                        </ul>
                </li>
                <li><h3><a href="#header-functions">Functions</a></h3>
                <ul class="">
                        <li><code><a title="sudoku_generator.CreateOrigin" href="#sudoku_generator.CreateOrigin">CreateOrigin</a></code></li>
                        <li><code><a title="sudoku_generator.RemoveNums" href="#sudoku_generator.RemoveNums">RemoveNums</a></code></li>
                        <li><code><a title="sudoku_generator.WriteFiles" href="#sudoku_generator.WriteFiles">WriteFiles</a></code></li>
                </ul>
        </li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
</footer>
</body>
</html>